.. _worldScreen Functions:

=====================
worldScreen Functions
=====================

.. toctree::
   :maxdepth: 1
   :hidden:
   :glob:

   worldScreen_*

+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| **Function**                                                                                        | **Description**                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:CheckIfPaused<worldScreen_CheckIfPaused>`                                        |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:ContainerScrollEnabled<worldScreen_ContainerScrollEnabled>`                      |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:GetCurrentTimeString<worldScreen_GetCurrentTimeString>`                          |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:GetHardPaused<worldScreen_GetHardPaused>`                                        |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:GetInControlOfDialog<worldScreen_GetInControlOfDialog>`                          |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:GetPickPartyCharacterId<worldScreen_GetPickPartyCharacterId>`                    |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:GetPickPartyPortrait<worldScreen_GetPickPartyPortrait>`                          |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:GetPickPartyRemoveCharacterId<worldScreen_GetPickPartyRemoveCharacterId>`        |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:GetTopContainerItem<worldScreen_GetTopContainerItem>`                            |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:GetTopGroundItem<worldScreen_GetTopGroundItem>`                                  |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:GetTopGroupItem<worldScreen_GetTopGroupItem>`                                    |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:GroundScrollEnabled<worldScreen_GroundScrollEnabled>`                            |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:GroupScrollEnabled<worldScreen_GroupScrollEnabled>`                              |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:IsPickPartyDoneButtonClickable<worldScreen_IsPickPartyDoneButtonClickable>`      |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:IsPickPartyRemoveButtonClickable<worldScreen_IsPickPartyRemoveButtonClickable>`  |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnContainerButtonClick<worldScreen_OnContainerButtonClick>`                      |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnContainerScroll<worldScreen_OnContainerScroll>`                                |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnDeathLoad<worldScreen_OnDeathLoad>`                                            |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnDeathQuit<worldScreen_OnDeathQuit>`                                            |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnDialogReplyClick<worldScreen_OnDialogReplyClick>`                              |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnGroundButtonClick<worldScreen_OnGroundButtonClick>`                            |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnGroundScroll<worldScreen_OnGroundScroll>`                                      |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnGroupScroll<worldScreen_OnGroupScroll>`                                        |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnHelpButtonClick<worldScreen_OnHelpButtonClick>`                                |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnPickPartyDoneButtonClick<worldScreen_OnPickPartyDoneButtonClick>`              |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnPickPartyPortraitButtonClick<worldScreen_OnPickPartyPortraitButtonClick>`      |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnQuickSaveButtonClick<worldScreen_OnQuickSaveButtonClick>`                      |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:OnSelectionButtonClick<worldScreen_OnSelectionButtonClick>`                      |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:RemoveCharacterFromParty<worldScreen_RemoveCharacterFromParty>`                  |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:SetHighlightEnabled<worldScreen_SetHighlightEnabled>`                            |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:StartGroundItems<worldScreen_StartGroundItems>`                                  |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:StepDialog<worldScreen_StepDialog>`                                              |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:StopGroundItems<worldScreen_StopGroundItems>`                                    |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:SwapPortraits<worldScreen_SwapPortraits>`                                        |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:TakeAllFromContainer<worldScreen_TakeAllFromContainer>`                          |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`worldScreen\:TogglePauseGame<worldScreen_TogglePauseGame>`                                    |                                                                                             |
+-----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+


::

   e = g_pBaldurChitin
   worldScreen = e:GetEngineWorld()